chore: add licence for docs #3343

derberg · 2024-10-29T08:50:12Z

During the Marketing Working Group meeting, we had an inquiry about our cheat sheet, if its content can be reused outside AsyncAPI org.

So yeah, it is time to finally do what Linux Foundation expected from us when we joined it - set a proper documentation license.

Zero creativity here, I just copy how other Linux Foundation does it https://github.com/linuxfoundation/auth0-cas-server-go. It works nice as then info about 2 different licances is visible not only in readme, but also because of filename, GH also supports and see it, and displays info about 2 licences

Having proper licenses in place also means we protect our community from any possible legal issues

Summary by CodeRabbit

New Features
- Added a full text of the Creative Commons Attribution 4.0 International Public License to the LICENSE-docs.
- Introduced a new "License" section in the README.md, detailing licensing terms for the source code and documentation.
Documentation
- Enhanced clarity on licensing terms and conditions for users engaging with the project.

netlify · 2024-10-29T08:50:28Z

✅ Deploy Preview for asyncapi-website ready!

Name	Link
🔨 Latest commit	`1c90824`
🔍 Latest deploy log	https://app.netlify.com/sites/asyncapi-website/deploys/672210b9c55c610008645860
😎 Deploy Preview	https://deploy-preview-3343--asyncapi-website.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

codecov · 2024-10-29T08:51:41Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 49.14%. Comparing base (35fed2f) to head (1c90824).
Report is 1 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #3343   +/-   ##
=======================================
  Coverage   49.14%   49.14%           
=======================================
  Files          21       21           
  Lines         647      647           
=======================================
  Hits          318      318           
  Misses        329      329

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

coderabbitai · 2024-10-29T08:53:10Z

Walkthrough

The changes include the addition of the full text of the Creative Commons Attribution 4.0 International Public License to the LICENSE-docs file, detailing key terms and conditions. Additionally, a new "License" section has been added to the README.md file, specifying that the source code is licensed under the Apache License, Version 2.0, while the documentation is under the CC-BY-4.0 license. Minor reorganization of the existing content in the README.md file was also performed.

Changes

File	Change Summary
LICENSE-docs	Added full text of the Creative Commons Attribution 4.0 International Public License.
README.md	Added "License" section detailing licensing terms for source code (Apache License 2.0) and documentation (CC-BY-4.0). Minor content reorganization.

Poem

In the meadow where ideas bloom,
A license now brings light to the room.
With terms defined, we share with glee,
Creativity flows, wild and free!
A hop, a skip, let knowledge ignite,
Together we flourish, in day and in night! 🐇✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

asyncapi-bot · 2024-10-29T08:53:56Z

⚡️ Lighthouse report for the changes in this PR:

Category	Score
🔴 Performance	41
🟢 Accessibility	98
🟢 Best practices	92
🟢 SEO	100
🔴 PWA	33

Lighthouse ran on https://deploy-preview-3343--asyncapi-website.netlify.app/

sambhavgupta0705 · 2024-10-29T13:14:00Z

@thulieblack @AceTheCreator PTAL

akshatnema

Approved ✅ , but I will wait for @thulieblack to get her approval as well.

akshatnema · 2024-10-29T17:09:25Z

@derberg I think we should configure CodeRabbitAI to check for good branch names as well 😉

derberg · 2024-10-30T10:56:42Z

@akshatnema

derberg · 2024-10-30T13:59:41Z

/rtm

chore: add licence for docs

13ca008

derberg requested review from quetzalliwrites, akshatnema, magicmatatjahu, Mayaleeeee, asyncapi-bot-eve and anshgoyalevil as code owners October 29, 2024 08:50

asyncapi-bot requested review from devilkiller-ag, sambhavgupta0705, BhaswatiRoy, J0SAL, TRohit20 and VaishnaviNandakumar October 29, 2024 08:50

Merge branch 'master' into licencjonowany

e2fa5b5

akshatnema approved these changes Oct 29, 2024

View reviewed changes

Merge branch 'master' into licencjonowany

1c90824

thulieblack approved these changes Oct 30, 2024

View reviewed changes

asyncapi-bot added the ready-to-merge label Oct 30, 2024

asyncapi-bot merged commit 2148afb into asyncapi:master Oct 30, 2024
19 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: add licence for docs #3343

chore: add licence for docs #3343

derberg commented Oct 29, 2024 •

edited by coderabbitai bot

Loading

netlify bot commented Oct 29, 2024 •

edited

Loading

codecov bot commented Oct 29, 2024 •

edited

Loading

coderabbitai bot commented Oct 29, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

asyncapi-bot commented Oct 29, 2024 •

edited

Loading

sambhavgupta0705 commented Oct 29, 2024

akshatnema left a comment

akshatnema commented Oct 29, 2024

derberg commented Oct 30, 2024

derberg commented Oct 30, 2024

chore: add licence for docs #3343

chore: add licence for docs #3343

Conversation

derberg commented Oct 29, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

netlify bot commented Oct 29, 2024 • edited Loading

✅ Deploy Preview for asyncapi-website ready!

codecov bot commented Oct 29, 2024 • edited Loading

Codecov Report

coderabbitai bot commented Oct 29, 2024 • edited Loading

Walkthrough

Changes

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

asyncapi-bot commented Oct 29, 2024 • edited Loading

sambhavgupta0705 commented Oct 29, 2024

akshatnema left a comment

Choose a reason for hiding this comment

akshatnema commented Oct 29, 2024

derberg commented Oct 30, 2024

derberg commented Oct 30, 2024

derberg commented Oct 29, 2024 •

edited by coderabbitai bot

Loading

netlify bot commented Oct 29, 2024 •

edited

Loading

codecov bot commented Oct 29, 2024 •

edited

Loading

coderabbitai bot commented Oct 29, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

asyncapi-bot commented Oct 29, 2024 •

edited

Loading